🌎 rns.kin.earth git 🌍
docs/source/git.rst 66096acc290ef0b8fd3b2831de83d17cd74df0b4 (66096acc) Text, 38.27 KB
Tb4b4b4.. Tff7b72_git-main:
Tc9d1d9******************
Tc9d1d9Git Over Reticulum
Tc9d1d9******************
A set of utilities for distributed collaborative software development and publishing are included in RNS.
The system consists of two parts: The Ta5d6ff``Ta5d6ffrngitTa5d6ff`` node that hosts repositories, and the Ta5d6ff``Ta5d6ffgit-remote-rnsTa5d6ff`` helper that enables Git to communicate with rngit nodes. As soon as you have RNS installed on your system, you can transparently use Git with Reticulum-hosted repositories just like any other type of remote. Git over Reticulum uses URLs in the following format: Ta5d6ff``Ta5d6ffrns://DESTINATION_HASH/group/repoTa5d6ff``.
If you set a branch to track a Reticulum remote as the default upstream, you can simply use Ta5d6ff``Ta5d6ffgitTa5d6ff`` as you normally would; all commands work transparently and as expected.
Tb4b4b4.. Tff7b72warningTb4b4b4::
**The rngit program is a new addition to RNS!** This functionality was introduced in RNS 1.2.0. While great care has been taken to design a secure, but highly configurable and flexible Ta5d6ff`permission system`_ for allowing many users to interact with many different repositories on a single node, Ta5d6ff``Ta5d6ffrngitTa5d6ff`` has not been tested extensively in the wild! Be careful when hosting repositories, especially if they are public or semi-public.
Tb4b4b4 .. Tff7b72_permission system: #permissions
Tc9d1d9The rngit Utility
Tc9d1d9=================
The Ta5d6ff``Ta5d6ffrngitTa5d6ff`` utility provides full Git repository hosting and interaction over Reticulum. It allows you to host and manage Git repositories and releases on Reticulum nodes, and to interact with remote repositories using standard Git commands through the Ta5d6ff``Ta5d6ffrns://Ta5d6ff`` URL scheme.
**Usage Examples**
Run Ta5d6ff``Ta5d6ffrngitTa5d6ff`` to start a repository node:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit
[Notice] Starting Reticulum Git Node...
[Notice] Reticulum Git Node listening on <0d7334d411d00120cbad24edf355fdd2>
On the first run, Ta5d6ff``Ta5d6ffrngitTa5d6ff`` will create a default configuration file. You will then need to edit this, to point to your repository locations, configure access permissions, and perform any other necessary configuration.
Them, view your identity and destination hashes:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit --print-identity
Git Peer Identity : <959e10e5efc1bd9d97a4083babe51dea>
Repository Node Identity : <153cb870b4665b8c1c348896292b0bad>
Repositories Destination : <0d7334d411d00120cbad24edf355fdd2>
If the page node is enabled, the output will also include the Nomad Network destination hash.
You can run Ta5d6ff``Ta5d6ffrngitTa5d6ff`` in service mode with logging to file:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit -s
Clone a repository from a remote Ta5d6ff``Ta5d6ffrngitTa5d6ff`` node:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ git clone rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo
Add a Reticulum remote to an existing repository:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ git remote add some_remote rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo
Push changes to the Reticulum remote:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ git push some_remote master
Get changes from a remote repository:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ git pull rns_remote master
Fork an existing repository from a remote to your Ta5d6ff``Ta5d6ffrngitTa5d6ff`` node:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit fork rns://8a37cdd16938ce79861561adbd59023a/reticulum/lxmf rns://50824b711717f97c2fb1166ceddd5ea9/public/myfork
**All Command-Line Options (rngit)**
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
usage: rngit.py [-h] [--config CONFIG] [--rnsconfig RNSCONFIG] [-s] [-i] [-v]
[-q] [--version]
Reticulum Git Repository Node
options:
-h, --help show this help message and exit
--config CONFIG path to alternative config directory
--rnsconfig RNSCONFIG
path to alternative Reticulum config directory
-p, --print-identity print identity and destination info and exit
-s, --service rngit is running as a service and should log to file
-i, --interactive drop into interactive shell after initialisation
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
--version show program's version number and exit
**All Command-Line Options (git-remote-rns)**
The Ta5d6ff``Ta5d6ffgit-remote-rnsTa5d6ff`` helper is automatically invoked by Git when interacting with Ta5d6ff``Ta5d6ffrns://Ta5d6ff`` URLs. It is not typically run directly by users, but accepts the following environment variables for configuration:
T79c0ff- Ta5d6ff``Ta5d6ffRNGIT_CONFIGTa5d6ff`` - Path to alternative client configuration directory
T79c0ff- Ta5d6ff``Ta5d6ffRNS_CONFIGTa5d6ff`` - Path to alternative Reticulum configuration directory
The client configuration file is located at Ta5d6ff``Ta5d6ff~/.rngit/client_configTa5d6ff`` and allows adjusting parameters such as the reference batch size for transfers.
Tc9d1d9Repository Creation & Management
Tc9d1d9================================
The Ta5d6ff``Ta5d6ffrngitTa5d6ff`` utility provides several ways to create and manage repositories on a node: creating empty repositories, forking from existing repositories, and mirroring remote repositories.
Tc9d1d9Creating Empty Repositories
Tc9d1d9---------------------------
To create a new empty repository on a remote node:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit create rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo
Repository public/myrepo created
This creates a bare Git repository at the specified path. You must have Ta5d6ff``Ta5d6ffcreateTa5d6ff`` permission for the target group. When a repository is created, the creator automatically receives Ta5d6ff``Ta5d6ffadmTa5d6ff`` (admin) permissions on the repository through an auto-generated Ta5d6ff``Ta5d6ff.allowedTa5d6ff`` file.
**All Command-Line Options (rngit create)**
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
usage: rngit create [-h] [--config CONFIG] [--rnsconfig RNSCONFIG]
[-i PATH] [-v] [-q] [--version]
repository
Reticulum Git Repository Creation
positional arguments:
repository URL of repository to create
options:
-h, --help show this help message and exit
--config CONFIG path to alternative config directory
--rnsconfig RNSCONFIG
path to alternative Reticulum config directory
-i, --identity PATH path to identity
-v, --verbose
-q, --quiet
--version show program's version number and exit
Tc9d1d9Forking Repositories
Tc9d1d9--------------------
Forking creates a copy of an existing repository (from any accessible Git URL) on your Ta5d6ff``Ta5d6ffrngitTa5d6ff`` node. Forks maintain a reference to their upstream source for later synchronization.
To fork a repository:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit fork https://github.com/user/original rns://50824b711717f97c2fb1166ceddd5ea9/public/myfork
Repository forked to public/myfork
The source can be any valid Git URL, including:
T79c0ff- HTTPS URLs: Ta5d6ff``Ta5d6ffhttps://github.com/user/repo.gitTa5d6ff``
T79c0ff- Git URLs: Ta5d6ff``Ta5d6ffgit://host.com/repo.gitTa5d6ff``
T79c0ff- SSH URLs: Ta5d6ff``Ta5d6ffssh://git@host.com/repo.gitTa5d6ff``
T79c0ff- Reticulum URLs: Ta5d6ff``Ta5d6ffrns://DESTINATION_HASH/group/repoTa5d6ff``
T79c0ff- Local paths: Ta5d6ff``Ta5d6ff/path/to/repo.gitTa5d6ff``
Forks are created as bare repositories with metadata tracking their origin. The fork process:
T79c0ff1. Creates a new bare repository
T79c0ff2. Fetches all refs (Ta5d6ff``Ta5d6ff+refs/*:refs/*Ta5d6ff``) from the source
T79c0ff3. Sets Ta5d6ff``Ta5d6ffrepository.rngit.typeTa5d6ff`` to Ta5d6ff``Ta5d6ffforkTa5d6ff``
T79c0ff4. Sets Ta5d6ff``Ta5d6ffrepository.rngit.upstream.sourceTa5d6ff`` to the source URL
T79c0ff5. Grants creator admin permissions
**All Command-Line Options (rngit fork)**
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
usage: rngit fork [-h] [--config CONFIG] [--rnsconfig RNSCONFIG]
[-i PATH] [-v] [-q] [--version]
source target
Reticulum Git Repository Forker
positional arguments:
source URL of source repository
target URL of target repository
options:
-h, --help show this help message and exit
--config CONFIG path to alternative config directory
--rnsconfig RNSCONFIG
path to alternative Reticulum config directory
-i, --identity PATH path to identity
-v, --verbose
-q, --quiet
--version show program's version number and exit
Tc9d1d9Mirroring Repositories
Tc9d1d9----------------------
Mirrors are similar to forks but are designed for keeping a local copy synchronized with an upstream repository. Mirrors can be automatically updated on a configurable schedule.
To create a mirror:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit mirror https://github.com/user/upstream rns://50824b711717f97c2fb1166ceddd5ea9/public/mymirror
Repository mirrored to public/mymirror
Mirrors are created with the same process as forks, but with Ta5d6ff``Ta5d6ffrepository.rngit.typeTa5d6ff`` set to Ta5d6ff``Ta5d6ffmirrorTa5d6ff`` and an additional Ta5d6ff``Ta5d6ffrepository.rngit.upstream.syncTa5d6ff`` timestamp tracking the last successful synchronization.
**All Command-Line Options (rngit mirror)**
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
usage: rngit mirror [-h] [--config CONFIG] [--rnsconfig RNSCONFIG]
[-i PATH] [-v] [-q] [--version]
source target
Reticulum Git Mirror Management
positional arguments:
source URL of source repository
target URL of target repository
options:
-h, --help show this help message and exit
--config CONFIG path to alternative config directory
--rnsconfig RNSCONFIG
path to alternative Reticulum config directory
-i, --identity PATH path to identity
-v, --verbose
-q, --quiet
--version show program's version number and exit
Tc9d1d9Automatic Mirror Synchronization
Tc9d1d9--------------------------------
The Ta5d6ff``Ta5d6ffrngitTa5d6ff`` node can automatically keep mirrors synchronized with their upstream sources. This is configured in the main configuration file:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
[rngit]
mirror_interval = 24
The Ta5d6ff``Ta5d6ffmirror_intervalTa5d6ff`` specifies the synchronization interval in hours (default: 24). The node checks for mirrors needing sync every 15 minutes, and fetches updates from upstream if the configured interval has elapsed since the last sync.
For automatic sync to happen, the repository must have been created with Ta5d6ff``Ta5d6ffrngit mirrorTa5d6ff``. Sync failures are logged but do not prevent future retry attempts. The sync timestamp is only updated on successful completion.
Tc9d1d9Manual Synchronization
Tc9d1d9----------------------
Both forks and mirrors can be manually synchronized on demand using the Ta5d6ff``Ta5d6ffsyncTa5d6ff`` command:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit sync rns://50824b711717f97c2fb1166ceddd5ea9/public/myfork
Repository synced
This fetches all refs from the upstream source configured when the repository was created. You must have Ta5d6ff``Ta5d6ffreadTa5d6ff`` and Ta5d6ff``Ta5d6ffwriteTa5d6ff`` permissions for the repository to perform a manual sync.
For mirrors, manual sync also updates the sync timestamp, effectively resetting the automatic sync timer.
**All Command-Line Options (rngit sync)**
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
usage: rngit sync [-h] [--config CONFIG] [--rnsconfig RNSCONFIG]
[-i PATH] [-v] [-q] [--version]
repository
Reticulum Git Repository Syncer
positional arguments:
repository URL of repository
options:
-h, --help show this help message and exit
--config CONFIG path to alternative config directory
--rnsconfig RNSCONFIG
path to alternative Reticulum config directory
-i, --identity PATH path to identity
-v, --verbose
-q, --quiet
--version show program's version number and exit
Tc9d1d9Git Configuration Parameters
Tc9d1d9----------------------------
Repositories created through Ta5d6ff``Ta5d6ffrngitTa5d6ff`` store metadata in Git configuration:
T79c0ff- Ta5d6ff``Ta5d6ffrepository.rngit.typeTa5d6ff`` - Either Ta5d6ff``Ta5d6ffforkTa5d6ff`` or Ta5d6ff``Ta5d6ffmirrorTa5d6ff``
T79c0ff- Ta5d6ff``Ta5d6ffrepository.rngit.upstream.sourceTa5d6ff`` - The source URL used during creation
T79c0ff- Ta5d6ff``Ta5d6ffrepository.rngit.upstream.syncTa5d6ff`` - Unix timestamp of last successful sync for mirrors
These parameters are used by the sync system and can be queried using standard Git commands:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ git config --get repository.rngit.type
mirror
$ git config --get repository.rngit.upstream.source
https://github.com/user/upstream
$ git config --get repository.rngit.upstream.sync
1716230400
Tc9d1d9Repository Structure
Tc9d1d9====================
The Ta5d6ff``Ta5d6ffrngitTa5d6ff`` node organizes repositories into groups. Each group is a directory containing bare Git repositories. The repository path format is Ta5d6ff``Ta5d6ffgroup_name/repo_nameTa5d6ff``. For example, a repository at Ta5d6ff``Ta5d6ff/var/git/public/myrepoTa5d6ff`` would be accessible as Ta5d6ff``Ta5d6ffpublic/myrepoTa5d6ff`` via the URL Ta5d6ff``Ta5d6ffrns://DESTINATION_HASH/public/myrepoTa5d6ff``.
Tc9d1d9Configuration
Tc9d1d9-------------
The Ta5d6ff``Ta5d6ffrngitTa5d6ff`` node configuration file is located at Ta5d6ff``Ta5d6ff~/.rngit/configTa5d6ff`` (or Ta5d6ff``Ta5d6ff/etc/rngit/configTa5d6ff`` for system-wide installations). The default configuration includes:
T79c0ff- Repository group paths defining where to find bare repositories
T79c0ff- Access permissions for groups and individual repositories
T79c0ff- Announce intervals for network visibility
T79c0ff- Optional statistics recording for repository activity
Tc9d1d9Permissions
Tc9d1d9===========
The Ta5d6ff``Ta5d6ffrngitTa5d6ff`` permission system provides fine-grained access control at multiple levels: group-level, repository-level, and document-level. Permissions can be statically configured in files or dynamically generated via executable scripts.
Access permissions can be configured at the group level in the config file or per-group Ta5d6ff``Ta5d6ff.allowedTa5d6ff`` files, or per-repository Ta5d6ff``Ta5d6ff.allowedTa5d6ff`` files. The Ta5d6ff``Ta5d6ffsTa5d6ff`` (stats) permission allows viewing repository activity statistics, including views, fetches and pushes over time. To enable statistics recording, set Ta5d6ff``Ta5d6ffrecord_stats = yesTa5d6ff`` in the Ta5d6ff``Ta5d6ff[rngit]Ta5d6ff`` section of the configuration file. You can also exclude specific identities from statistics by adding their hashes to Ta5d6ff``Ta5d6ffstats_ignore_identitiesTa5d6ff``.
By default, **no** permissions are granted for anything! You will have to enable the permissions you require to be able to actually *do* something with Ta5d6ff``Ta5d6ffrngitTa5d6ff``.
Permissions can be modified by editing the Ta5d6ff``Ta5d6ffrngitTa5d6ff`` config file, individual Ta5d6ff``Ta5d6ff.allowedTa5d6ff`` files on disk, or remotely using the Ta5d6ff``Ta5d6ffrngit permsTa5d6ff`` command.
Tc9d1d9Permission Types
Tc9d1d9----------------
The following permissions are supported:
T79c0ff- Ta5d6ff``Ta5d6ffrTa5d6ff`` (read) - Clone, fetch, and view repositories and work documents
T79c0ff- Ta5d6ff``Ta5d6ffwTa5d6ff`` (write) - Push changes and manage work documents
T79c0ff- Ta5d6ff``Ta5d6ffrwTa5d6ff`` (read/write) - Combined read and write access
T79c0ff- Ta5d6ff``Ta5d6ffcTa5d6ff`` (create) - Create, fork or mirror new repositories within a group
T79c0ff- Ta5d6ff``Ta5d6ffsTa5d6ff`` (stats) - View repository activity statistics
T79c0ff- Ta5d6ff``Ta5d6ffrelTa5d6ff`` (release) - Create and manage releases
T79c0ff- Ta5d6ff``Ta5d6ffiTa5d6ff`` (interact) - Comment on and interact with work documents
T79c0ff- Ta5d6ff``Ta5d6ffpTa5d6ff`` (propose) - Propose new work documents (without full write access)
T79c0ff- Ta5d6ff``Ta5d6ffadmTa5d6ff`` (admin) - Full access
Permission targets can be:
T79c0ff- Ta5d6ff``Ta5d6ffallTa5d6ff`` or Ta5d6ff``Ta5d6ffaTa5d6ff`` - Everyone
T79c0ff- Ta5d6ff``Ta5d6ffnoneTa5d6ff`` or Ta5d6ff``Ta5d6ffnTa5d6ff`` - Nobody
T79c0ff- A specific Reticulum identity hash
Tc9d1d9Permission Hierarchy
Tc9d1d9--------------------
Permissions are resolved in the following hierarchy:
T79c0ff1. **Repository-level permissions** - Checked first, if none exists group permissions are checked
T79c0ff2. **Group-level permissions** - Used as fallback if no repository-level permissions are set
T79c0ff3. **Admin override** - Finally, potential admin rights are checked
For work documents, work document specific permissions are always checked first, and work documents have additional specific checks such as modifications only being possible by the document author.
Tc9d1d9Configuration Methods
Tc9d1d9---------------------
**Group-Level Configuration**
Group permissions can be configured in the Ta5d6ff``Ta5d6ff[access]Ta5d6ff`` section of the main config file:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
[access]
public = r:all, w:9710b86ba12c42d1d8f30f74fe509286
internal = rw:9710b86ba12c42d1d8f30f74fe509286
collaborative = r:all, i:all, p:all, w:9710b86ba12c42d1d8f30f74fe509286
Additionally, they can be configured in a group Ta5d6ff``Ta5d6ffgroup_name.allowedTa5d6ff`` file, placed next to the Ta5d6ff``Ta5d6ffgroup_nameTa5d6ff`` group directory.
**Repository-Level Configuration**
Repository-specific permissions are set in Ta5d6ff``Ta5d6ff.allowedTa5d6ff`` files placed next to the repository directory (for example, Ta5d6ff``Ta5d6ffmyrepo.allowedTa5d6ff`` for Ta5d6ff``Ta5d6ffmyrepoTa5d6ff``):
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
# myrepo.allowed
r:all
w:9710b86ba12c42d1d8f30f74fe509286
rel:9710b86ba12c42d1d8f30f74fe509286
**Dynamic Permissions**
Permission files can be made executable to generate permissions dynamically:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ chmod +x myrepo.allowed
When executable, the script is run and its stdout is parsed as permission rules. This allows integration with external authentication systems.
Tc9d1d9Work Document Permissions
Tc9d1d9-------------------------
Work documents support additional permission granularity through Ta5d6ff``Ta5d6ff.allowedTa5d6ff`` files in the work directory (e.g., Ta5d6ff``Ta5d6ff42.allowedTa5d6ff`` for document #42). These files use the same permission syntax but only support:
T79c0ff- Ta5d6ff``Ta5d6ffrTa5d6ff`` (read) - View the document
T79c0ff- Ta5d6ff``Ta5d6ffwTa5d6ff`` (write) - Edit the document
T79c0ff- Ta5d6ff``Ta5d6ffiTa5d6ff`` (interact) - Comment on the document
T79c0ff- Ta5d6ff``Ta5d6ffpTa5d6ff`` (propose) - Propose changes (future use)
T79c0ff- Ta5d6ff``Ta5d6ffadmTa5d6ff`` (admin) - Full control over the document
Document permissions override repository permissions for that specific document. Work document permissions can be updated simply by editing the Ta5d6ff``Ta5d6ff.allowedTa5d6ff`` file, or remotely by using the Ta5d6ff``Ta5d6ffrngit workTa5d6ff`` command.
Tc9d1d9Creator Permissions
Tc9d1d9-------------------
When a user creates a repository (via Ta5d6ff``Ta5d6ffcreateTa5d6ff``, Ta5d6ff``Ta5d6ffforkTa5d6ff``, or Ta5d6ff``Ta5d6ffmirrorTa5d6ff``), they are automatically granted Ta5d6ff``Ta5d6ffadmTa5d6ff`` (admin) permissions on that repository.
When a user creates a work document, they automatically receive Ta5d6ff``Ta5d6ffinteractTa5d6ff`` and Ta5d6ff``Ta5d6ffwriteTa5d6ff`` permissions on that document.
Tc9d1d9Permission Examples
Tc9d1d9-------------------
**Example 1: Public Read, Restricted Write**
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
r:all
w:9710b86ba12c42d1d8f30f74fe509286
Everyone can read, only the specified identity can write.
**Example 2: Collaborative Development**
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
r:all
i:all
p:all
w:9710b86ba12c42d1d8f30f74fe509286
rel:9710b86ba12c42d1d8f30f74fe509286
Everyone can read, interact (comment), and propose work documents. Only the specified identity can write, create releases, and manage work documents fully.
**Example 3: Private Repository**
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
rw:9710b86ba12c42d1d8f30f74fe509286
rw:a1b2c3d4e5f686ba12c42d1ba12ef1aa
Only the two specified identities have any access (read or write).
**Example 4: Mirror with Stats**
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
r:all
s:all
w:none
Everyone can read and view stats, but nobody can push (mirror is read-only from upstream).
Tc9d1d9Permission Short Forms
Tc9d1d9----------------------
Permissions can be specified using short or long forms:
T79c0ff- Ta5d6ff``Ta5d6ffrTa5d6ff`` = Ta5d6ff``Ta5d6ffreadTa5d6ff``
T79c0ff- Ta5d6ff``Ta5d6ffwTa5d6ff`` = Ta5d6ff``Ta5d6ffwriteTa5d6ff``
T79c0ff- Ta5d6ff``Ta5d6ffrwTa5d6ff`` = Ta5d6ff``Ta5d6ffreadwriteTa5d6ff``
T79c0ff- Ta5d6ff``Ta5d6ffcTa5d6ff`` = Ta5d6ff``Ta5d6ffcreateTa5d6ff``
T79c0ff- Ta5d6ff``Ta5d6ffsTa5d6ff`` = Ta5d6ff``Ta5d6ffstatsTa5d6ff``
T79c0ff- Ta5d6ff``Ta5d6ffrelTa5d6ff`` = Ta5d6ff``Ta5d6ffreleaseTa5d6ff``
T79c0ff- Ta5d6ff``Ta5d6ffiTa5d6ff`` = Ta5d6ff``Ta5d6ffinteractTa5d6ff``
T79c0ff- Ta5d6ff``Ta5d6ffpTa5d6ff`` = Ta5d6ff``Ta5d6ffproposeTa5d6ff``
T79c0ff- Ta5d6ff``Ta5d6ffadmTa5d6ff`` = Ta5d6ff``Ta5d6ffadminTa5d6ff``
Targets can also use short forms:
T79c0ff- Ta5d6ff``Ta5d6ffaTa5d6ff`` = Ta5d6ff``Ta5d6ffallTa5d6ff`` = Ta5d6ff``Ta5d6ffeveryoneTa5d6ff``
T79c0ff- Ta5d6ff``Ta5d6ffnTa5d6ff`` = Ta5d6ff``Ta5d6ffnoneTa5d6ff`` = Ta5d6ff``Ta5d6ffnobodyTa5d6ff``
Tc9d1d9Permission Configuration Locations
Tc9d1d9----------------------------------
T79c0ff- User install: Ta5d6ff``Ta5d6ff~/.rngit/configTa5d6ff``
T79c0ff- System install: Ta5d6ff``Ta5d6ff/etc/rngit/configTa5d6ff``
T79c0ff- Group permissions: Ta5d6ff``Ta5d6ff<group_root>/<group_name>.allowedTa5d6ff``
T79c0ff- Repository permissions: Ta5d6ff``Ta5d6ff<group_root>/<group_name>/<repo_name>.allowedTa5d6ff``
T79c0ff- Document permissions: Ta5d6ff``Ta5d6ff<group_root>/<group_name>.work/<doc_id>.allowedTa5d6ff``
Tc9d1d9Identity & Destination Aliases
Tc9d1d9==============================
To make permission and remote destination management easier, you can locally define aliases for commonly used identity and destination hashes. Identity aliases used in permissions resolution can be defined in the Ta5d6ff``Ta5d6ff[aliases]Ta5d6ff`` section of the Ta5d6ff``Ta5d6ff~/.rngit/configTa5d6ff`` file, while destination aliases are defined in the Ta5d6ff``Ta5d6ff[aliases]Ta5d6ff`` section of the Ta5d6ff``Ta5d6ff~/.rngit/client_configTa5d6ff`` file.
All alias definitions take the form of Ta5d6ff``Ta5d6ffaliased_name = HASHTa5d6ff``:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
[aliases]
alice = d09285e660cfe27cee6d9a0beb58b7e0
bob = ffcffb4e255e156e77f79b82c13086a6
**Aliases are always resolved locally!** If for example you fork a repository with Ta5d6ff``Ta5d6ffrngit fork rns://bobs_node/public/repo_name rns://my_node/forks/repo_nameTa5d6ff``, the forked repository will of course still reference the full, original destination hash, and use this for subsequent upstream syncs.
Tc9d1d9Serving Pages Over Nomad Network
Tc9d1d9================================
In addition to providing Git repository access via the Git remote helper protocol and command-line tools, Ta5d6ff``Ta5d6ffrngitTa5d6ff`` can also run a Ta5d6ff`Nomad Network Tffd700<https://github.com/markqvist/nomadnet>Ta5d6ff`_ compatible page node. This allows users to browse repository information, view file contents, inspect commit history and access repository statistics through any Nomad Network client.
When enabled, the page node provides a complete interface to your repositories, with automatic Markdown to Micron conversion, syntax-highlighted code browsing, and detailed commit, diff and statistics views.
Tc9d1d9Enabling the Git Page Node
Tc9d1d9--------------------------
To enable the page node, add the following to your Ta5d6ff``Ta5d6ff~/.rngit/configTa5d6ff`` file:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
[pages]
serve_nomadnet = yes
When the page node is enabled, Ta5d6ff``Ta5d6ffrngitTa5d6ff`` will listen on a Nomad Network node destination in addition to the Git repository destination. You can view the destination hash by running:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit --print-identity
Git Peer Identity : <959e10e5efc1bd9d97a4083babe51dea>
Repository Node Identity : <153cb870b4665b8c1c348896292b0bad>
Repositories Destination : <0d7334d411d00120cbad24edf355fdd2>
Nomad Network Destination : <50824b711717f97c2fb1166ceddd5ea9>
Tc9d1d9Accessing Repository Pages
Tc9d1d9--------------------------
Once the page node is running, you can access it from any Nomad Network client by connecting to the Nomad Network destination. The page node provides the following views:
T79c0ff- **Front Page** - Lists all repository groups accessible to your identity
T79c0ff- **Group Page** - Shows all repositories within a group
T79c0ff- **Repository Page** - Displays repository overview, description and README
T79c0ff- **Releases** - List of releases for the repository, with information and downloads
T79c0ff- **File Browser** - Browse directory trees and view and download file contents
T79c0ff- **Commits View** - View commit history with pagination
T79c0ff- **Commit Details** - Detailed commit information with file changes and diffs
T79c0ff- **Refs View** - List branches and tags
T79c0ff- **Statistics** - Activity charts showing views, fetches and pushes over time
All pages respect the same permission system used for Git access. If an identity does not have read access to a repository, they will not be able to view its pages.
Tc9d1d9Formatting & Syntax Highlighting
Tc9d1d9--------------------------------
If the Ta5d6ff``Ta5d6ffpygmentsTa5d6ff`` Python module is installed on your system, the page node will automatically apply syntax highlighting to code files. The highlighting supports a wide range of programming languages and uses a color theme optimized for terminal display.
To enable syntax highlighting, install pygments:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
pip install pygments
**Markdown & Micron Support**
README files and other Markdown documents are automatically converted to Micron markup for display in Nomad Network clients. You can also write your README files directly in Micron, in which case they will display and render as such in any Nomad Network client. The file browser also supports viewing both rendered and raw Markdown and Micron documents.
Code blocks in Markdown can include language hints for syntax highlighting:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
```python
def hello_world():
print("Hello, Reticulum!")
```
Tc9d1d9Customizing Templates
Tc9d1d9---------------------
The page node uses a template system that allows complete customization of the generated pages. Templates are stored in the Ta5d6ff``Ta5d6ff~/.rngit/templates/Ta5d6ff`` directory as Micron files.
The following template files are supported:
T79c0ff- Ta5d6ff``Ta5d6ffbase.muTa5d6ff`` - Base template wrapping all pages
T79c0ff- Ta5d6ff``Ta5d6fffront.muTa5d6ff`` - Front page listing all groups
T79c0ff- Ta5d6ff``Ta5d6ffgroup.muTa5d6ff`` - Group page listing repositories
T79c0ff- Ta5d6ff``Ta5d6ffrepo.muTa5d6ff`` - Repository overview page
T79c0ff- Ta5d6ff``Ta5d6ffreleases.muTa5d6ff`` - Release list page
T79c0ff- Ta5d6ff``Ta5d6ffrelease.muTa5d6ff`` - Release details page
T79c0ff- Ta5d6ff``Ta5d6fftree.muTa5d6ff`` - File browser pages
T79c0ff- Ta5d6ff``Ta5d6ffblob.muTa5d6ff`` - File content display
T79c0ff- Ta5d6ff``Ta5d6ffcommits.muTa5d6ff`` - Commit history listing
T79c0ff- Ta5d6ff``Ta5d6ffcommit.muTa5d6ff`` - Individual commit detail page
T79c0ff- Ta5d6ff``Ta5d6ffrefs.muTa5d6ff`` - Branches and tags listing
T79c0ff- Ta5d6ff``Ta5d6ffstats.muTa5d6ff`` - Statistics page
Templates can include the following variables:
T79c0ff- Ta5d6ff``Ta5d6ff{PAGE_CONTENT}Ta5d6ff`` - The main content of the page (required)
T79c0ff- Ta5d6ff``Ta5d6ff{NODE_NAME}Ta5d6ff`` - The configured node name
T79c0ff- Ta5d6ff``Ta5d6ff{NAVIGATION}Ta5d6ff`` - Breadcrumb navigation links
T79c0ff- Ta5d6ff``Ta5d6ff{VERSION}Ta5d6ff`` - The rngit version number
T79c0ff- Ta5d6ff``Ta5d6ff{GEN_TIME}Ta5d6ff`` - Page generation time
**Dynamic Templates**
Templates can be made executable to generate dynamic content. If a template file has the executable bit set, it will be executed and its stdout used as the template content.
**Icon Sets**
By default, the page node uses Nerd Font icons. If you prefer simpler icons or your terminal does not support Nerd Fonts, you can enable Unicode icons instead:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
[pages]
serve_nomadnet = yes
unicode_icons = yes
Tc9d1d9Repository Statistics
Tc9d1d9---------------------
When statistics recording is enabled (see the Ta5d6ff``Ta5d6ffrecord_statsTa5d6ff`` configuration option), the page node can display activity charts for each repository. The statistics page shows:
T79c0ff- Total and peak views, downloads, fetches and pushes
T79c0ff- Daily activity charts over a 90-day period
T79c0ff- Combined activity visualization
To view statistics, a user must have the Ta5d6ff``Ta5d6ffsTa5d6ff`` (stats) permission for the repository. See the Access Configuration section for details on setting permissions.
**Repository Thanks**
The page node includes a "Thanks" feature that allows users to express appreciation for a repository. On each repository page, a "Thanks" link is displayed showing the current thanks count. Clicking this link registers a thank you for the repository.
Tc9d1d9Configuration Example
Tc9d1d9---------------------
A complete node configuration might look like this:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
[rngit]
node_name = My Git Node
announce_interval = 360
record_stats = yes
[repositories]
public = /var/git/public
internal = /var/git/internal
[access]
public = r:all
internal = rw:9710b86ba12c42d1d8f30f74fe509286
[pages]
serve_nomadnet = yes
unicode_icons = no
Tc9d1d9Release Management
Tc9d1d9==================
In addition to hosting Git repositories, Ta5d6ff``Ta5d6ffrngitTa5d6ff`` provides a complete release management system. This allows you to publish versioned releases with associated artifacts, release notes and metadata. Releases are managed through the Ta5d6ff``Ta5d6ffrngit releaseTa5d6ff`` subcommand, and are also viewable through the Nomad Network page interface.
Tc9d1d9The Release Workflow
Tc9d1d9--------------------
Creating a release involves specifying a Git tag and a directory containing build artifacts or other files to distribute. The Ta5d6ff``Ta5d6ffrngitTa5d6ff`` client will open your configured Ta5d6ff``Ta5d6ff$EDITORTa5d6ff`` to compose release notes, then upload all artifacts to the remote repository node.
To create a release, specify the tag name and path to artifacts:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit release rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo create v1.2.0:./dist
This will:
T79c0ff1. Verify that the tag Ta5d6ff``Ta5d6ffv1.2.0Ta5d6ff`` exists in the repository
T79c0ff2. Open your editor to write release notes
T79c0ff3. Upload all files from the Ta5d6ff``Ta5d6ff./distTa5d6ff`` directory
T79c0ff4. Publish the release
If no Ta5d6ff``Ta5d6ff$EDITORTa5d6ff`` environment variable is set, Ta5d6ff``Ta5d6ffrngitTa5d6ff`` will try to use Ta5d6ff``Ta5d6ffnanoTa5d6ff``, Ta5d6ff``Ta5d6ffvimTa5d6ff`` or Ta5d6ff``Ta5d6ffviTa5d6ff``. The editor will show a template with instructions. Lines starting with Ta5d6ff``Ta5d6ff#Ta5d6ff`` will be ignored, and if the remaining content is empty after stripping comments, the release creation will be cancelled.
Tc9d1d9Release Storage & Structure
Tc9d1d9---------------------------
Releases are stored on the node in a directory named Ta5d6ff``Ta5d6ffrepo_name.releasesTa5d6ff`` next to the bare repository. Each release is a subdirectory containing:
T79c0ff- Ta5d6ff``Ta5d6ffMETATa5d6ff`` - Release metadata in ConfigObj format
T79c0ff- Ta5d6ff``Ta5d6ffRELEASE.mdTa5d6ff`` or Ta5d6ff``Ta5d6ffRELEASE.muTa5d6ff`` - Release notes
T79c0ff- Ta5d6ff``Ta5d6ffartifacts/Ta5d6ff`` - All uploaded files
T79c0ff- Ta5d6ff``Ta5d6ffTHANKSTa5d6ff`` - Appreciation count from users
Tc9d1d9Command-Line Interaction
Tc9d1d9------------------------
**Listing Releases**
To view all releases for a repository:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit release rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo list
Tag Status Created Objs Notes
------------------------------------------------------------------
v1.2.0 published 2025-01-15 14:32 3 Another release
v1.1.0 published 2024-12-03 09:15 2 Bug fix release
v1.0.0 published 2024-10-20 16:45 2 Initial release
**Viewing Release Details**
To see full information about a specific release:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit release rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo view v1.2.0
Release : 0.9.2
Status : published
Created : 2026-05-04 23:53:09
Thanks : 5
Release Notes
=============
Version 1.2.0 release notes...
Artifacts (4)
=============
- myapp-1.2.0.tar.gz (1.5 MB)
- myapp-1.2.0.zip (1.6 MB)
- checksums.txt (256 B)
**Deleting Releases**
To remove a release:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit release rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo delete v1.2.0
Are you sure you want to delete release 'v1.2.0'? [y/N]: y
Release v1.2.0 deleted
**Requirements & Validation**
T79c0ff- The specified tag must exist in the remote repository
T79c0ff- You must have Ta5d6ff``Ta5d6ffreleaseTa5d6ff`` permission for the repository
T79c0ff- The target artifacts directory must exist and contain at least one file
T79c0ff- Release notes cannot be empty
**Permissions**
Release management requires the Ta5d6ff``Ta5d6ffreleaseTa5d6ff`` permission, configured the same way as other repository permissions. In the config file or Ta5d6ff``Ta5d6ff.allowedTa5d6ff`` files, use Ta5d6ff``Ta5d6ffrel:targetTa5d6ff`` to grant release management rights:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
# In .allowed file or config
rel:all # Allow everyone
rel:9710b86... # Allow specific identity
rel:none # Deny everyone
**Nomad Network Interface**
When the Nomad Network page node is enabled, releases are displayed on a dedicated releases page for each repository. Each release is listed with its tag, creation date, artifact count and a preview of the release notes. Clicking a release shows the full details including formatted release notes and a listing of all artifacts with their sizes.
**All Command-Line Options (rngit release)**
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
usage: rngit release [-h] [--config CONFIG] [--rnsconfig RNSCONFIG]
[-i PATH] [-v] [-q] [--version]
[repository] [operation] [target]
Reticulum Git Release Manager
positional arguments:
repository URL of remote repository
operation list, view, create or delete
target tag and path to release artifacts directory
options:
-h, --help show this help message and exit
--config CONFIG path to alternative config directory
--rnsconfig RNSCONFIG
path to alternative Reticulum config directory
-i, --identity PATH path to release identity
-v, --verbose
-q, --quiet
--version show program's version number and exit
Tb4b4b4.. Tff7b72rawTb4b4b4:: latex
\newpage
Tc9d1d9Work Documents
Tc9d1d9==============
In addition to releases, Ta5d6ff``Ta5d6ffrngitTa5d6ff`` provides a work document management system for tracking tasks, investigations, issues and progress related to repositories. Work documents are stored as structured msgpack data and support threaded updates and comments.
Tc9d1d9Working With Work Documents
Tc9d1d9---------------------------
**Listing Work Documents**
To view work documents for a repository:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit work rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo list
Active documents
=================
ID Title Author Created Comments
---------------------------------------------------------------------------
1 Implemented new feature 9710b86ba12c4f2e… 2025-01-15 14:32 3
2 Fixed bug in parser 8f3a21c9d84e927b… 2025-01-14 09:15 1
Use Ta5d6ff``Ta5d6ff--scope completedTa5d6ff`` to view completed work documents, Ta5d6ff``Ta5d6ff--scope proposedTa5d6ff`` to view proposed documents, or Ta5d6ff``Ta5d6ff--scope allTa5d6ff`` to see all scopes.
**Viewing a Work Document**
To view a specific work document with all its comments:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit work rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo view -d 1
Implement new feature (active #1)
=================================
Author : 9710b86ba12c42d1d8f30f74fe509286
Status : active
Created : 2026-05-05 15:11:11
Edited : 2026-05-05 18:22:11
Format : markdown
Updates : 0
This work document tracks the implementation of the new feature...
Updates
=======
#1 by 9710b86ba12c42d1d8f30f74fe509286 at 2026-05-05 15:38:37
-------------------------------------------------------------
Initial analysis complete
**Creating Work Documents**
To create a new work document:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit work rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo create --title "Investigate performance issue"
This will open your configured Ta5d6ff``Ta5d6ff$EDITORTa5d6ff`` to compose the document content. Save and exit to create the document, or save an empty document to cancel.
**Editing Work Documents**
To edit an existing work document:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit work rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo edit -d 1
This fetches the current content, opens it in your editor, and sends any changes back to the node.
**Adding Comments**
To add an update to a work document:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit work rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo update -d 1
This opens your editor to compose the update.
Tc9d1d9Proposing Work Documents
Tc9d1d9------------------------
Users with Ta5d6ff``Ta5d6ffproposeTa5d6ff`` permission can create work document proposals without full Ta5d6ff``Ta5d6ffwriteTa5d6ff`` access. Proposals are created in a "proposed" state and must be activated by a user with appropriate permissions before becoming active.
To propose a work document:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit work rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo propose --title "Feature proposal"
This opens your editor to compose the proposal content. When saved, the document is created in the "proposed" scope. The creator automatically receives Ta5d6ff``Ta5d6ffinteractTa5d6ff`` and Ta5d6ff``Ta5d6ffwriteTa5d6ff`` permissions on the proposed document.
Proposed documents are visible through Ta5d6ff``Ta5d6ff--scope proposedTa5d6ff`` or Ta5d6ff``Ta5d6ff--scope allTa5d6ff``:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit work rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo list --scope proposed
**Permissions for Proposals**
T79c0ff- Creating proposals requires Ta5d6ff``Ta5d6ffproposeTa5d6ff`` permission on the repository
T79c0ff- The creator automatically gets Ta5d6ff``Ta5d6ffinteractTa5d6ff`` and Ta5d6ff``Ta5d6ffwriteTa5d6ff`` on their proposed document
T79c0ff- Activating a proposal requires Ta5d6ff``Ta5d6ffwriteTa5d6ff`` and Ta5d6ff``Ta5d6ffinteractTa5d6ff`` permissions
Tc9d1d9State Management
Tc9d1d9----------------
**Completing Work Documents**
To mark a work document as completed (moving it from Ta5d6ff``Ta5d6ffactiveTa5d6ff`` to Ta5d6ff``Ta5d6ffcompletedTa5d6ff``):
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit work rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo complete -d 1
Work document #1 completed
**Activating Work Documents**
To mark a work document as active (moving it from Ta5d6ff``Ta5d6ffcompletedTa5d6ff`` to Ta5d6ff``Ta5d6ffactiveTa5d6ff``):
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit work rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo activate -d 1
Work document #1 activated
**Deleting Work Documents**
To delete a work document and all its comments:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit work rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo delete -id 1
Are you sure you want to delete active work document #1? [y/N]: y
Work document #1 deleted
Tc9d1d9Managing Work Document Permissions
Tc9d1d9----------------------------------
Users with administrative access to a work document can manage its specific permissions. This allows fine-grained control over who can read, write, comment on, or administer individual work documents.
To view or edit permissions for a work document:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
$ rngit work rns://50824b711717f97c2fb1166ceddd5ea9/public/myrepo perms -d 1
This opens your editor with the current permission configuration:
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
r:all
i:9710b86ba12c42d1d8f30f74fe509286
adm:9710b86ba12c42d1d8f30f74fe509286
Permission rules follow the same format as repository permissions:
T79c0ff- Ta5d6ff``Ta5d6ffr:targetTa5d6ff`` - Grant read access
T79c0ff- Ta5d6ff``Ta5d6ffw:targetTa5d6ff`` - Grant write access
T79c0ff- Ta5d6ff``Ta5d6ffi:targetTa5d6ff`` - Grant interact (comment) access
T79c0ff- Ta5d6ff``Ta5d6ffadm:targetTa5d6ff`` - Grant admin access
Targets can be Ta5d6ff``Ta5d6ffallTa5d6ff``, Ta5d6ff``Ta5d6ffnoneTa5d6ff``, or a specific identity hash.
**Who Can Edit Permissions**
Document permissions can be edited by:
T79c0ff- The original author (if they also have Ta5d6ff``Ta5d6ffinteractTa5d6ff`` and Ta5d6ff``Ta5d6ffwriteTa5d6ff`` on the repository)
T79c0ff- Any user with Ta5d6ff``Ta5d6ffadminTa5d6ff`` permission on the document
T79c0ff- Repository admins (through inherited permissions)
**Permission Precedence**
Document-specific permissions override repository-level permissions for that document. If document permissions exist, they are checked first; if access is not granted there, repository permissions are checked.
**Author Rights:**
T79c0ff- Users can only edit or delete work documents they created
T79c0ff- The author is cryptographically verified from the interacting link's Ta5d6ff``Ta5d6ffremote_identityTa5d6ff``
T79c0ff- Document creators automatically receive Ta5d6ff``Ta5d6ffinteractTa5d6ff`` and Ta5d6ff``Ta5d6ffwriteTa5d6ff`` on their documents
**Storage Format**
Work documents are stored in a Ta5d6ff``Ta5d6ffrepo_name.workTa5d6ff`` directory next to the repository, containing:
T79c0ff- Ta5d6ff``Ta5d6ffactive/Ta5d6ff`` - Active work documents
T79c0ff- Ta5d6ff``Ta5d6ffcompleted/Ta5d6ff`` - Completed work documents
T79c0ff- Ta5d6ff``Ta5d6ffproposed/Ta5d6ff`` - Proposed work documents
Each document is a numbered directory containing:
T79c0ff- Ta5d6ff``Ta5d6ffrootTa5d6ff`` - The work document content and metadata (msgpack format)
T79c0ff- Ta5d6ff``Ta5d6ffNTa5d6ff`` - Numbered comment files (msgpack format)
**Nomad Network Interface**
When the Nomad Network page node is enabled, work documents are viewable through the web interface. The work page lists all documents with their status, and clicking a document shows its full content and updates.
**All Command-Line Options (rngit work)**
Tb4b4b4.. Tff7b72codeTb4b4b4:: Tff7b72text
usage: rngit work [-h] [--config CONFIG] [--rnsconfig RNSCONFIG]
[-i PATH] [--scope SCOPE] [-t TITLE] [-d ID] [-v]
[-q] [--version]
[repository] [operation]
Reticulum Git Work Document Manager
positional arguments:
repository URL of remote repository
operation list, view, create, propose, edit, delete,
update, complete, activate or perms
options:
-h, --help show this help message and exit
--config CONFIG path to alternative config directory
--rnsconfig RNSCONFIG
path to alternative Reticulum config directory
-i, --identity PATH path to identity
--scope SCOPE document scope: active, completed, proposed or all
-t, --title TITLE document title for create/propose
-d, --id ID document ID
-v, --verbose
-q, --quiet
--version show program's version number and exit
Served by rngit 1.5.2 - Generated in 0.09s